/*
 * Fichier: Chapter.java
 * Crée le: 07 mai 2007.
 * Modifié: 20 juin 2012.
 * Auteurs: Sébastien ESTIENNE.
 * SiteWeb: http://www.prog-info.org/
 * 
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 * 
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 */

package javaexos.business;



import java.util.ArrayList;
import java.util.Calendar;
import java.util.Collections;
import java.util.List;

import javaexos.model.ChapterModel;
import javaexos.model.ChapterMutableModel;
import javaexos.model.ExerciseModel;
import javaexos.model.ExerciseMutableModel;



/**
 * <p>Classe décrivant un chapitre.</p>
 * @author Sébastien ESTIENNE.
 */
public class Chapter implements ChapterMutableModel
{
   /** Numéro du chapitre. */
   private int number;

   /** Titre du chapitre. */
   private String title;
   
   /** Nom du chapitre. */
   private String name;

   /** Date de création du chapitre. */
   private Calendar creation;

   /** Auteur du chapitre. */
   private String author;

   /** Indique si le chapitre est validé. */
   private boolean validated;

   /** Mots clés du chapitre. */
   private List<String> keyWords;

   /** Présentation du chapitre. */
   private String presentation;

   /** Notions du chapitre. */
   private List<String> notions;

   /** Contributeurs du chapitre. */
   private List<String> contributors;

   /** Exercices du chapitre. */
   private List<ExerciseMutableModel> exercises;


   /**
    * <p>Constructeur par défaut de chapitre.</p>
    */
   public Chapter()
   {
      // Initialisation.
      this(0, "", Calendar.getInstance(), "");
   }


   /**
    * <p>Construit le chapitre.</p>
    * @param number Le numéro du chapitre.
    * @param title Le titre du chapitre.
    * @param creation La date de création du chapitre.
    * @param author L'auteur du chapitre.
    */
   public Chapter(int number, String title, Calendar creation, String author)
   {
      // Initialisation.
      setNumber(number);
      setTitle(title);
      setName(""); 
      setCreation(creation);
      setAuthor(author);
      this.keyWords = new ArrayList<String>();
      setPresentation("");
      this.notions = new ArrayList<String>();
      this.contributors = new ArrayList<String>();
      this.exercises = new ArrayList<ExerciseMutableModel>();
   }


   /**
    * <p>Renvoie le numéro du chapitre.</p>
    * @return Retourne le numéro du chapitre.
    */
   public int getNumber()
   {
      return this.number;
   }


   /**
    * <p>Modifie le numéro du chapitre.</p>
    * @param number Le nouveau numéro du chapitre.
    */
   public void setNumber(int number)
   {
      assert (number > 0) : "'number' doit être strictement positif!";

      this.number = number;
   }


   /**
    * <p>Renvoie le titre du chapitre.</p>
    * @return Retourne le titre du chapitre.
    */
   public String getTitle()
   {
      return this.title;
   }


   /**
    * <p>Modifie le titre du chapitre.</p>
    * @param title Le nouveau titre du chapitre.
    */
   public void setTitle(String title)
   {
      assert (title != null) : "'title' ne doit pas être null!";

      this.title = title;
   }
   
   
   /**
    * <p>Renvoie le nom du chapitre.</p>
    * @return Retourne le nom du chapitre.
    */
   public String getName()
   {
      return this.name;
   }


   /**
    * <p>Modifie le nom du chapitre.</p>
    * @param name Le nouveau nom du chapitre.
    */
   public void setName(String name)
   {
      this.name = name;
   }


   /**
    * <p>Renvoie la date de création du chapitre.</p>
    * @return Retourne la date de création du chapitre.
    */
   public Calendar getCreation()
   {
      Calendar c = (Calendar) this.creation.clone();

      return c;
   }


   /**
    * <p>Modifie la date de création du chapitre.</p>
    * @param creation La nouvelle date de création du chapitre.
    */
   public void setCreation(Calendar creation)
   {
      assert (creation != null) : "'creation' ne doit pas être null!";

      this.creation = creation;
   }


   /**
    * <p>Renvoie le nom de l'auteur du chapitre.</p>
    * @return Retourne le nom de l'auteur du chapitre.
    */
   public String getAuthor()
   {
      return this.author;
   }


   /**
    * <p>Modifie le nom de l'auteur du chapitre.</p>
    * @param author Le nouvel auteur du chapitre.
    */
   public void setAuthor(String author)
   {
      assert (author != null) : "'author' ne doit pas être null!";

      this.author = author;
   }


   /**
    * <p>Renvoie true si le chapitre est validé, sinon false.</p>
    * @return Retourne true si le chapitre est validé, sinon false.
    */
   public boolean isValidated()
   {
      return this.validated;
   }


   /**
    * <p>Modifie la validité du chapitre.</p>
    * @param validated La nouvelle valeur de validité du chapitre.
    */
   public void setValidated(boolean validated)
   {
      this.validated = validated;
   }


   /**
    * <p>Renvoie la liste des mots clés du chapitre.</p>
    * @return Retourne la liste des mots clés du chapitre.
    */
   public List<String> getKeyWords()
   {
      return Collections.unmodifiableList(this.keyWords);
   }


   /**
    * <p>Modifie la liste des mots clés du chapitre.</p>
    * @param keyWords La nouvelle liste des mots clés du chapitre.
    */
   public void setKeyWords(List<String> keyWords)
   {
      assert (keyWords != null) : "'keyWords' ne doit pas être null!";

      this.keyWords.clear();
      this.keyWords.addAll(keyWords);
   }


   /**
    * <p>Renvoie la présentation du chapitre.</p>
    * @return Retourne la présentation du chapitre.
    */
   public String getPresentation()
   {
      return this.presentation;
   }


   /**
    * <p>Modifie la présentation du chapitre.</p>
    * @param presentation La nouvelle présentation du chapitre.
    */
   public void setPresentation(String presentation)
   {
      assert (presentation != null) : "'presentation' ne doit pas être null!";

      this.presentation = presentation;
   }


   /**
    * <p>Renvoie la liste des notions du chapitre.</p>
    * @return Retourne la liste des notions du chapitre.
    */
   public List<String> getNotions()
   {
      return Collections.unmodifiableList(this.notions);
   }


   /**
    * <p>Modifie la liste des notions du chapitre.</p>
    * @param notions La nouvelle liste des notions du chapitre.
    */
   public void setNotions(List<String> notions)
   {
      assert (notions != null) : "'notions' ne doit pas être null!";

      this.notions.clear();
      this.notions.addAll(notions);
   }


   /**
    * <p>Renvoie la liste des contributeurs du chapitre.</p>
    * @return Retourne la liste des contributeurs du chapitre.
    */
   public List<String> getContributors()
   {
      return Collections.unmodifiableList(this.contributors);
   }


   /**
    * <p>Modifie la liste des contributeurs du chapitre.</p>
    * @param contributors La nouvelle liste des contributeurs du chapitre.
    */
   public void setContributors(List<String> contributors)
   {
      assert (contributors != null) : "'contributors' ne doit pas être null!";

      this.contributors.clear();
      this.contributors.addAll(contributors);
   }


   /**
    * <p>Renvoie la liste des exercices du chapitre.</p>
    * @return Retourne la liste des exercices du chapitre.
    */
   public List< ? extends ExerciseModel> getExercises()
   {
      return Collections.unmodifiableList(this.exercises);
   }


   /**
    * <p>Modifie la liste des exercices du chapitre.</p>
    * @param exercises La nouvelle liste des exercices du chapitre.
    */
   public void setExercises(List<ExerciseMutableModel> exercises)
   {
      assert (exercises != null) : "'exercises' ne doit pas être null!";

      this.exercises.clear();
      this.exercises.addAll(exercises);
   }


   /**
    * <p>Compare deux chapitres.</p>
    * @param chapter Le chapitre à comparer.
    * @return Un entier négatif, zéro, ou un entier négatif si cet objet est plus petit que, égal à,
    *         ou plus grand que le numéro du chapitre spécifié.
    */
   public int compareTo(ChapterModel chapter)
   {
      if(getNumber() == chapter.getNumber())
      {
         return 0;
      }
      else if(getNumber() > chapter.getNumber())
      {
         return 1;
      }
      else
      {
         return -1;
      }
   }


   /**
    * <p>Retourne une représentation du chapitre.</p>
    * @return Renvoie une représentation du chapitre.
    */
   @Override
   public String toString()
   {
      StringBuilder resultat = new StringBuilder();

      resultat.append(this.number).append(" - ").append(this.title);

      return resultat.toString();
   }
}
